docs: de-template tidy continuation guide#45
Merged
Conversation
A durable in-repo guide (docs/developer/TIDY-CONTINUATION-GUIDE.adoc) so the context and discipline of the de-templating effort travel with the code: what snifs is + ground-truth numbers; the non-negotiable rules (licence flag-only, signed commits, the strict pre-commit hook, stop-before-push, look-before- delete); the remaining work-packages (WP-4/WP-5) and open decisions (D-a..D-f); the working method; and the repo-specific gotchas (snif vs snifs + the substring trap, phantom recipes, DOC-FORMAT, the AI-manifest convention, Containerfile-at- root, settings.yml rename risk). Live PR state is a dated snapshot that points at `gh pr list` so it does not go stale. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
🔍 Hypatia Security ScanFindings: 53 issues detected
View findings[
{
"reason": "Action actions/checkout@v4 needs attention",
"type": "unpinned_action",
"file": "rust-guest-verify.yml",
"action": "pin_sha",
"rule_module": "workflow_audit",
"severity": "medium"
},
{
"reason": "Issue in rust-guest-verify.yml",
"type": "missing_timeout_minutes",
"file": "rust-guest-verify.yml",
"action": "flag",
"rule_module": "workflow_audit",
"severity": "medium"
},
{
"reason": "Issue in scorecard-enforcer.yml",
"type": "scorecard_publish_with_run_step",
"file": "scorecard-enforcer.yml",
"action": "split_scorecard_publish_job",
"rule_module": "workflow_audit",
"severity": "high"
},
{
"reason": "Issue in instant-sync.yml",
"type": "secret_action_without_presence_gate",
"file": "instant-sync.yml",
"action": "peter-evans/repository-dispatch",
"rule_module": "workflow_audit",
"severity": "high"
},
{
"reason": "Issue in scorecard.yml",
"type": "scorecard_wrapper_missing_job_permissions",
"file": "scorecard.yml",
"action": "flag",
"rule_module": "workflow_audit",
"severity": "high"
},
{
"reason": "Issue in codeql.yml",
"type": "codeql_missing_actions_language",
"file": "codeql.yml",
"action": "flag",
"rule_module": "workflow_audit",
"severity": "medium"
},
{
"reason": "Python file detected -- banned language",
"type": "banned_language_file",
"file": "/home/runner/work/snifs/snifs/benches/assert_safer.py",
"action": "flag",
"rule_module": "cicd_rules",
"severity": "critical"
},
{
"reason": "Python file detected -- banned language",
"type": "banned_language_file",
"file": "/home/runner/work/snifs/snifs/verification/tools/abi_conformance.py",
"action": "flag",
"rule_module": "cicd_rules",
"severity": "critical"
},
{
"reason": "unsafe block -- requires SAFETY comment (4 occurrences, CWE-676)",
"type": "unsafe_block",
"file": "/home/runner/work/snifs/snifs/rust/crates/snif-abi/src/lib.rs",
"action": "flag",
"rule_module": "code_safety",
"severity": "medium"
},
{
"reason": "unsafe block -- requires SAFETY comment (1 occurrences, CWE-676)",
"type": "unsafe_block",
"file": "/home/runner/work/snifs/snifs/rust/crates/demo-guest/src/lib.rs",
"action": "flag",
"rule_module": "code_safety",
"severity": "medium"
}
]Powered by Hypatia Neurosymbolic CI/CD Intelligence |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds
docs/developer/TIDY-CONTINUATION-GUIDE.adoc— a durable guide so any agent or maintainer can continue the snifs de-templating effort with the same context and discipline, travelling with the code rather than living only in a session.Covers: what snifs is + the ground-truth numbers; the non-negotiable rules (licence flag-only, signed commits, the strict pre-commit hook, stop-before-push, look-before-delete); the remaining work (WP-4 load-bearing config, WP-5 deletions) and open decisions (D-a…D-f); the working method; and the repo-specific gotchas (
snifvssnifs+ substring trap, phantom recipes, DOC-FORMAT, the AI-manifest convention,Containerfile-at-root,settings.ymlrename risk).Live PR state is a dated snapshot that points at
gh pr list, so it won't go stale.🤖 Generated with Claude Code